Azure Maps Time Zone Service (preview:1.0)

2025/10/15 • 6 deleted methods

Timezone_GetTimezoneByID (removed)
Description :  The `Get Timezone By ID` API is an HTTP `GET` request that returns current, historical, and future time zone information for the specified IANA time zone ID.
Reference :  Link ¶

⚼ Request

GET:  /timezone/byId/{format}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the language code in which the timezone names should be returned. If no language code is provided, the response will be in "EN". Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
options:
{
Description: Alternatively, use alias "o". Options available for types of information returned in the result. ,
Required: False ,
}
string ,
timeStamp:
{
Description: Alternatively, use alias "stamp", or "s". Reference time, if omitted, the API will use the machine time serving the request. ,
Format: date-time ,
Required: False ,
}
string ,
transitionsFrom:
{
Description: Alternatively, use alias "tf". The start date from which daylight savings time (DST) transitions are requested, only applies when "options" = all or "options" = transitions. ,
Format: date-time ,
Required: False ,
}
string ,
transitionsYears:
{
Description: Alternatively, use alias "ty". The number of years from "transitionsFrom" for which DST transitions are requested, only applies when "options" = all or "options" = transitions. ,
Required: False ,
}
integer ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: The IANA time zone ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
Version:
{
Description: Version property ,
Required: False ,
}
string ,
ReferenceUtcTimestamp:
{
Description: Reference Utc Timestamp property ,
Format: date-time ,
Required: False ,
}
string ,
TimeZones:
{
Description: TimeZoneId array ,
Required: False ,
}
[
{
Id:
{
Description: Id property ,
Required: False ,
}
string ,
Aliases:
{
Description: An array of time zone ID aliases. Only returned when [options]=*zoneinfo* or *all*. Note: may be null. ,
Required: False ,
}
[
string ,
]
,
Countries:
{
Description: An array of country/region records. Only returned when [options]=*zoneinfo* or *all*. ,
Required: False ,
}
[
{
Name:
{
Description: country/region Name ,
Required: False ,
}
string ,
Code:
{
Description: ISO-3166 2-letter country/region code for the country/region. ,
Required: False ,
}
string ,
}
,
]
,
Names:
{
Description: Timezone names object. ,
Required: False ,
}
{
ISO6391LanguageCode:
{
Description: The ISO 639-1 language code of the Names ,
Required: False ,
}
string ,
Generic:
{
Description: Generic Name ,
Required: False ,
}
string ,
Standard:
{
Description: Standard Name ,
Required: False ,
}
string ,
Daylight:
{
Description: Daylight Name ,
Required: False ,
}
string ,
}
,
ReferenceTime:
{
Description: Details in effect at the local time. ,
Required: False ,
}
{
Tag:
{
Description: Time zone name in effect at the reference timestamp (i.e. PST or PDT depending whether Daylight Savings Time is in effect). ,
Required: False ,
}
string ,
StandardOffset:
{
Description: UTC offset in effect at the `ReferenceUTCTimestamp`. ,
Required: False ,
}
string ,
DaylightSavings:
{
Description: Time saving in minutes in effect at the `ReferenceUTCTimestamp`. ,
Required: False ,
}
string ,
WallTime:
{
Description: Current wall time at the given time zone as shown in the `Tag` property. ,
Required: False ,
}
string ,
PosixTzValidYear:
{
Description: The year this POSIX string is valid for. Note: A POSIX string will only be valid in the given year. ,
Required: False ,
}
integer ,
PosixTz:
{
Description: POSIX string used to set the time zone environment variable. ,
Required: False ,
}
string ,
Sunrise:
{
Description: Sunrise at the given time zone as shown in the `Tag` property, populated only when the call is `byCoordinates`. The sunrise is described in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Note that the Timezone API does not return sunrise and sunset times when solar day is observed in the requested region. ,
Format: date-time ,
Required: False ,
}
string ,
Sunset:
{
Description: Sunset at the given time zone as shown in the `Tag` property, populated only when the call is `byCoordinates`. The sunset is described in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Note that the Timezone API does not return sunrise and sunset times when solar day is observed in the requested region. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
RepresentativePoint:
{
Description: Representative point property ,
Required: False ,
}
{
Latitude:
{
Description: Latitude property ,
Required: False ,
}
number ,
Longitude:
{
Description: Longitude property ,
Required: False ,
}
number ,
}
,
TimeTransitions:
{
Description: Time zone DST transitions from [transitionsFrom] until timestamp + 1 year. ,
Required: False ,
}
[
{
Tag:
{
Description: Tag property ,
Required: False ,
}
string ,
StandardOffset:
{
Description: StandardOffset property ,
Required: False ,
}
string ,
DaylightSavings:
{
Description: DaylightSavings property ,
Required: False ,
}
string ,
UtcStart:
{
Description: Start date, start time for this transition period ,
Format: date-time ,
Required: False ,
}
string ,
UtcEnd:
{
Description: End date, end time for this transition period ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Timezone_GetTimezoneByCoordinates (removed)
Description :  The `Get Timezone By Coordinates` API is an HTTP `GET` request that returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location, with the exception of regions that observe solar days.
Reference :  Link ¶

⚼ Request

GET:  /timezone/byCoordinates/{format}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
Accept-Language:
{
Description: Specifies the language code in which the timezone names should be returned. If no language code is provided, the response will be in "EN". Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
options:
{
Description: Alternatively, use alias "o". Options available for types of information returned in the result. ,
Required: False ,
}
string ,
timeStamp:
{
Description: Alternatively, use alias "stamp", or "s". Reference time, if omitted, the API will use the machine time serving the request. ,
Format: date-time ,
Required: False ,
}
string ,
transitionsFrom:
{
Description: Alternatively, use alias "tf". The start date from which daylight savings time (DST) transitions are requested, only applies when "options" = all or "options" = transitions. ,
Format: date-time ,
Required: False ,
}
string ,
transitionsYears:
{
Description: Alternatively, use alias "ty". The number of years from "transitionsFrom" for which DST transitions are requested, only applies when "options" = all or "options" = transitions. ,
Required: False ,
}
integer ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: Coordinates of the point for which time zone information is requested. This parameter is a list of coordinates, containing a pair of coordinate(lat, long). When this endpoint is called directly, coordinates are passed in as a single string containing coordinates, separated by commas. ,
Required: True ,
}
array ,
}

⚐ Response (200)

{
Version:
{
Description: Version property ,
Required: False ,
}
string ,
ReferenceUtcTimestamp:
{
Description: Reference Utc Timestamp property ,
Format: date-time ,
Required: False ,
}
string ,
TimeZones:
{
Description: TimeZoneId array ,
Required: False ,
}
[
{
Id:
{
Description: Id property ,
Required: False ,
}
string ,
Aliases:
{
Description: An array of time zone ID aliases. Only returned when [options]=*zoneinfo* or *all*. Note: may be null. ,
Required: False ,
}
[
string ,
]
,
Countries:
{
Description: An array of country/region records. Only returned when [options]=*zoneinfo* or *all*. ,
Required: False ,
}
[
{
Name:
{
Description: country/region Name ,
Required: False ,
}
string ,
Code:
{
Description: ISO-3166 2-letter country/region code for the country/region. ,
Required: False ,
}
string ,
}
,
]
,
Names:
{
Description: Timezone names object. ,
Required: False ,
}
{
ISO6391LanguageCode:
{
Description: The ISO 639-1 language code of the Names ,
Required: False ,
}
string ,
Generic:
{
Description: Generic Name ,
Required: False ,
}
string ,
Standard:
{
Description: Standard Name ,
Required: False ,
}
string ,
Daylight:
{
Description: Daylight Name ,
Required: False ,
}
string ,
}
,
ReferenceTime:
{
Description: Details in effect at the local time. ,
Required: False ,
}
{
Tag:
{
Description: Time zone name in effect at the reference timestamp (i.e. PST or PDT depending whether Daylight Savings Time is in effect). ,
Required: False ,
}
string ,
StandardOffset:
{
Description: UTC offset in effect at the `ReferenceUTCTimestamp`. ,
Required: False ,
}
string ,
DaylightSavings:
{
Description: Time saving in minutes in effect at the `ReferenceUTCTimestamp`. ,
Required: False ,
}
string ,
WallTime:
{
Description: Current wall time at the given time zone as shown in the `Tag` property. ,
Required: False ,
}
string ,
PosixTzValidYear:
{
Description: The year this POSIX string is valid for. Note: A POSIX string will only be valid in the given year. ,
Required: False ,
}
integer ,
PosixTz:
{
Description: POSIX string used to set the time zone environment variable. ,
Required: False ,
}
string ,
Sunrise:
{
Description: Sunrise at the given time zone as shown in the `Tag` property, populated only when the call is `byCoordinates`. The sunrise is described in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Note that the Timezone API does not return sunrise and sunset times when solar day is observed in the requested region. ,
Format: date-time ,
Required: False ,
}
string ,
Sunset:
{
Description: Sunset at the given time zone as shown in the `Tag` property, populated only when the call is `byCoordinates`. The sunset is described in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Note that the Timezone API does not return sunrise and sunset times when solar day is observed in the requested region. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
RepresentativePoint:
{
Description: Representative point property ,
Required: False ,
}
{
Latitude:
{
Description: Latitude property ,
Required: False ,
}
number ,
Longitude:
{
Description: Longitude property ,
Required: False ,
}
number ,
}
,
TimeTransitions:
{
Description: Time zone DST transitions from [transitionsFrom] until timestamp + 1 year. ,
Required: False ,
}
[
{
Tag:
{
Description: Tag property ,
Required: False ,
}
string ,
StandardOffset:
{
Description: StandardOffset property ,
Required: False ,
}
string ,
DaylightSavings:
{
Description: DaylightSavings property ,
Required: False ,
}
string ,
UtcStart:
{
Description: Start date, start time for this transition period ,
Format: date-time ,
Required: False ,
}
string ,
UtcEnd:
{
Description: End date, end time for this transition period ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Timezone_GetTimezoneEnumWindows (removed)
Description :  The `Get Windows Time Zones` API is an HTTP `GET` request that returns a full list of Windows Time Zone IDs.
Reference :  Link ¶

⚼ Request

GET:  /timezone/enumWindows/{format}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
WindowsId:
{
Description: Windows Id property ,
Required: False ,
}
string ,
Territory:
{
Description: Territory property ,
Required: False ,
}
string ,
IanaIds:
{
Description: IanaIds array ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Timezone_GetTimezoneEnumIANA (removed)
Description :  The `Get IANA Time Zones` API is an HTTP `GET` request that returns a full list of Internet Assigned Numbers Authority (IANA) time zone IDs. Updates to the IANA service are reflected in the system within one day.
Reference :  Link ¶

⚼ Request

GET:  /timezone/enumIana/{format}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
Id:
{
Description: Id property ,
Required: False ,
}
string ,
IsAlias:
{
Description: IsAlias property ,
Required: False ,
}
boolean ,
AliasOf:
{
Description: AliasOf property ,
Required: False ,
}
string ,
HasZone1970Location:
{
Description: This attribute returns `True` if the IanaId has any country/zone associated with it. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Timezone_GetTimezoneIANAVersion (removed)
Description :  The `Get Time Zone IANA Version` API is an HTTP `GET` request that returns the current Internet Assigned Numbers Authority (IANA) version number as Metadata.
Reference :  Link ¶

⚼ Request

GET:  /timezone/ianaVersion/{format}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
Version:
{
Description: Version property ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Timezone_GetTimezoneWindowsToIANA (removed)
Description :  The `Get Windows to IANA Time Zone` API is an HTTP `GET` request that returns a corresponding Internet Assigned Numbers Authority (IANA) ID, given a valid Windows Time Zone ID. Multiple IANA IDs may be returned for a single Windows ID. It is possible to narrow these results by adding an optional territory parameter.
Reference :  Link ¶

⚼ Request

GET:  /timezone/windowsToIana/{format}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
format:
{
Description: Desired format of the response. Only `json` format is supported. ,
Required: True ,
}
string ,
query:
{
Description: The Windows time zone ID. ,
Required: True ,
}
string ,
territory:
{
Description: Windows Time Zone territory code. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
Id:
{
Description: Id property ,
Required: False ,
}
string ,
IsAlias:
{
Description: IsAlias property ,
Required: False ,
}
boolean ,
AliasOf:
{
Description: AliasOf property ,
Required: False ,
}
string ,
HasZone1970Location:
{
Description: This attribute returns `True` if the IanaId has any country/zone associated with it. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}